/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * This file is part of retabel.
 *
 * Copyright (c) 2011 by individual contributors as indicated by the
 * @author tags. See the copyright.txt file in the distribution
 * for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.retabel.service.manager;

import org.retabel.persistence.entity.document.ContentTypeEnum;
import org.retabel.persistence.entity.document.ExportConfiguration;

import javax.ejb.Local;

/**
 * Service for managing export configurations
 * <p/>
 * <h3>Extra-Info</h3>
 * Created: 18:56 01.07.11
 *
 * @author Peter Herber
 * @version 1.0
 */
@Local
public interface ExportConfigurationManager {

    /**
     * Retrieve a range of export configurations
     *
     * @param from       the index of the first result export configuration
     * @param maxResults retrieve up to maxResults results
     * @return the export configurations
     */
    ExportConfiguration[] findRange(int from, int maxResults);

    /**
     * Retrieve the number of export configurations
     *
     * @return the number export configurations
     */
    int count();

    /**
     * Stores an export configuration into database
     *
     * @param name the export configuration unique name
     * @param contentType the content type
     * @param location the export configuration location
     */
    void store(String name, ContentTypeEnum contentType, String location);

    /**
     * Removes an export configuration, identified by it's unique name
     *
     * @param name the export configuration name
     */
    void remove(String name);
}
